Submitter fetches pending transactions independently per chain #2376

dwasse · 2024-03-27T20:49:03Z

Description
Addresses issue where the GetTXS() query for pending transactions enforces inter-chain limit instead of intra-chain limit. Instead of introducing an overly complex raw SQL query, we add a GetChainIDsByStatus() helper to the submitter db and get transactions with individual queries per chain.

Summary by CodeRabbit

New Features
- Enhanced data querying capabilities by introducing a function to retrieve chain IDs based on specific criteria.
Tests
- Ensured reliability and robustness by adding comprehensive tests for the new chain ID retrieval functionality.
Refactor
- Improved code structure and efficiency for fetching and processing pending transactions.

…hain

coderabbitai · 2024-03-27T20:49:11Z

Walkthrough

The recent updates focus on enhancing chain ID management in Ethergo by introducing the GetChainIDsByStatus method across components. These changes, alongside import adjustments and code reorganization, aim to streamline the handling of pending transactions.

Changes

File Path	Summary
`.../db/mocks/service.go` `.../db/service.go` `.../db/txdb/store.go`	Added `GetChainIDsByStatus` function to retrieve chain IDs by status. Included `math/big` import.
`.../db_test.go`	Added test for `GetChainIDsByStatus` function.
`.../submitter/queue.go`	Imported additional packages, restructured code for fetching and processing pending transactions.

"In the realm of code, where logic plays,
A rabbit hopped, through the Ethergo maze.
🐰 With a leap and a bound, it found a way,
To fetch chain IDs, both night and day.
🌟 'Twas a change so bright, in the ledger's haze,
Guiding transactions, through the blockchain's craze."

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

cloudflare-workers-and-pages · 2024-03-27T20:53:40Z

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`cbe85ea`
Status:	✅ Deploy successful!
Preview URL:	https://1419c050.sanguine-fe.pages.dev
Branch Preview URL:	https://feat-submitter-bump-fairness.sanguine-fe.pages.dev

View logs

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 490d295 and 97c0e6f.

Files selected for processing (5)

ethergo/submitter/db/mocks/service.go (1 hunks)
ethergo/submitter/db/service.go (2 hunks)
ethergo/submitter/db/txdb/store.go (3 hunks)
ethergo/submitter/db_test.go (1 hunks)
ethergo/submitter/queue.go (3 hunks)

Additional comments: 10

ethergo/submitter/db/service.go (2)

8-8: The addition of the math/big package is appropriate given the use of *big.Int in the new method GetChainIDsByStatus.

39-40: The new method GetChainIDsByStatus is a significant addition. It's crucial to ensure that the method's implementation in the corresponding implementation files (e.g., store.go) correctly handles the logic for fetching distinct chain IDs based on the given address and status. This method enhances the granularity of transaction fetching, aligning with the PR's objectives.

ethergo/submitter/queue.go (4)

6-8: The addition of math/big, sync, and time packages supports the new functionality for handling transactions with big.Int chain IDs and concurrent processing.

64-66: Fetching distinct chain IDs for pending transactions using GetChainIDsByStatus is a key improvement. It ensures that transactions are fetched and processed per chain, adhering to intra-chain limits. Proper error handling is observed here, which is crucial for robustness.

69-73: Converting *big.Int chain IDs to int64 for logging purposes is a sensible approach. However, ensure that this conversion does not lead to any loss of information, especially for very large chain IDs that might exceed the int64 range.

77-93: The concurrent processing of transactions per chain ID is a significant enhancement. It leverages goroutines for parallel processing, which can improve the efficiency of transaction processing. Ensure that the sync.WaitGroup is correctly used to wait for all goroutines to complete.

ethergo/submitter/db_test.go (1)

163-207: The addition of TestGetChainIDsByStatus is crucial for verifying the new functionality. It appears to adequately test the retrieval of chain IDs by status, ensuring that the implementation behaves as expected. Consider adding more test cases to cover edge cases, such as no transactions matching the status or transactions across a wide range of chain IDs.

ethergo/submitter/db/mocks/service.go (1)

65-93: The addition of the mock function GetChainIDsByStatus is essential for unit testing components that depend on the Service interface. It correctly mirrors the signature of the actual method, allowing for effective mocking of behavior in tests. Ensure that tests utilizing this mock properly simulate various return scenarios to cover different edge cases.

ethergo/submitter/db/txdb/store.go (2)

8-8: The addition of the math/big package is necessary for handling chain IDs as *big.Int, aligning with the changes made in this PR.

357-383: The implementation of GetChainIDsByStatus in store.go is a key part of this PR's objective to fetch transactions with awareness of individual chains. This method's implementation seems to correctly fetch distinct chain IDs for a given address and status. Ensure that the method is thoroughly tested, especially for cases with a large number of transactions and chain IDs.

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 97c0e6f and 49fa679.

Files selected for processing (1)

ethergo/submitter/db/service.go (2 hunks)

Files skipped from review as they are similar to previous changes (1)

ethergo/submitter/db/service.go

codecov · 2024-03-27T21:02:09Z

Codecov Report

Attention: Patch coverage is 61.90476% with 8 lines in your changes are missing coverage. Please review.

Project coverage is 46.89678%. Comparing base (490d295) to head (cbe85ea).
Report is 11 commits behind head on master.

Files	Patch %	Lines
ethergo/submitter/queue.go	61.90476%	7 Missing and 1 partial ⚠️

Additional details and impacted files

@@                 Coverage Diff                 @@
##              master       #2376         +/-   ##
===================================================
+ Coverage   46.89341%   46.89678%   +0.00336%     
===================================================
  Files            399         399                 
  Lines          30548       30565         +17     
  Branches          83          83                 
===================================================
+ Hits           14325       14334          +9     
- Misses         14695       14701          +6     
- Partials        1528        1530          +2

Flag	Coverage Δ
cctp-relayer	`43.41463% <ø> (ø)`
committee	`62.76446% <ø> (-1.20717%)`	⬇️
ethergo	`60.24119% <61.90476%> (-0.07125%)`	⬇️
explorer	`24.80122% <ø> (ø)`
omnirpc	`53.23194% <ø> (ø)`
promexporter	`75.91241% <ø> (ø)`
rfq	`29.09708% <ø> (ø)`
scribe	`52.21130% <ø> (+0.18426%)`	⬆️
sin-executor	`64.17910% <ø> (+2.23880%)`	⬆️
stiprelayer	`3.33333% <ø> (ø)`
tools	`21.98661% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 49fa679 and cbe85ea.

Files selected for processing (1)

ethergo/submitter/db/txdb/store.go (4 hunks)

Files skipped from review as they are similar to previous changes (1)

ethergo/submitter/db/txdb/store.go

dwasse added 2 commits March 27, 2024 15:34

Feat: add GetChainIDsByStatus() to db service; fetch pending txs by c…

6b5e9d2

…hain

Feat: add TestGetChainIDsByStatus

97c0e6f

dwasse requested a review from trajan0x as a code owner March 27, 2024 20:49

github-actions bot added go Pull requests that update Go code size/s labels Mar 27, 2024

coderabbitai bot reviewed Mar 27, 2024

View reviewed changes

Merge branch 'master' into feat/submitter-bump-fairness

49fa679

coderabbitai bot reviewed Mar 27, 2024

View reviewed changes

dwasse added 3 commits March 27, 2024 17:35

[goreleaser]

43cfbb8

Fix: mark ReplacedOrConfirmed on Pending / Stored statuses

1e2a230

[goreleaser]

cbe85ea

coderabbitai bot reviewed Mar 28, 2024

View reviewed changes

dwasse merged commit 6e47707 into master Mar 29, 2024
61 of 62 checks passed

dwasse deleted the feat/submitter-bump-fairness branch March 29, 2024 17:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Submitter fetches pending transactions independently per chain #2376

Submitter fetches pending transactions independently per chain #2376

dwasse commented Mar 27, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 27, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

cloudflare-workers-and-pages bot commented Mar 27, 2024 •

edited

Loading

coderabbitai bot left a comment

coderabbitai bot left a comment

codecov bot commented Mar 27, 2024 •

edited

Loading

coderabbitai bot left a comment

Submitter fetches pending transactions independently per chain #2376

Submitter fetches pending transactions independently per chain #2376

Conversation

dwasse commented Mar 27, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Mar 27, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

cloudflare-workers-and-pages bot commented Mar 27, 2024 • edited Loading

Deploying sanguine-fe with Cloudflare Pages

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Mar 27, 2024 • edited Loading

Codecov Report

coderabbitai bot left a comment

Choose a reason for hiding this comment

dwasse commented Mar 27, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 27, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

cloudflare-workers-and-pages bot commented Mar 27, 2024 •

edited

Loading

codecov bot commented Mar 27, 2024 •

edited

Loading